Skip to content

Tighten the README and add a comparison section - #5

Open
AngelCodes95 wants to merge 1 commit into
mainfrom
docs/readme-and-comparison
Open

AngelCodes95 wants to merge 1 commit into
mainfrom
docs/readme-and-comparison

Conversation

@AngelCodes95

Copy link
Copy Markdown
Owner

What

  • README rewritten to lead with an example and cut repetition. Prose outside the synced AGENTS.md block went from about 1,870 words to about 1,470, including the new section.
  • New "How it compares" section: a table plus one paragraph each for Lore, QAC, Agent Note, and Agent Trace.
  • The CLI section is now a command list instead of one long paragraph.
  • "Try it" folded into "How to use it", which now covers init and manual setup, and which file each agent reads.
  • Gemini CLI note corrected: it reads GEMINI.md by default and can include AGENTS.md via context.fileName, instead of "unconfirmed".
  • SPEC.md cross-reference updated for the renamed CLI section.

How the comparison was checked

Every claim comes from the project's own source:

  • Lore: the arXiv paper (2603.15566)
  • QAC: the author's announcement post, which links its spec repo
  • Agent Note: its GitHub README
  • Agent Trace: agent-trace.dev, spec v0.1.0

Lore is credited as the closest relative and as earlier (a March 2026 preprint; this repo started in September 2026).

Verification

  • sync-docs:check is clean: the AGENTS.md block section was carried over unchanged.
  • 168 tests pass.
  • No em or en dashes.
  • Docs only, no code changes.

Leads with an example, turns the one-paragraph CLI description into a
command list, folds "Try it" into "How to use it", and adds "How it
compares" for Lore, QAC, Agent Note, and Agent Trace. Corrects the Gemini
CLI note.

Agent-Context: {"why":"the README was the main barrier to someone deciding whether to try this, and it never answered how this differs from the projects people will find next to it. Each comparison claim was checked against that project's own spec, paper, or README rather than secondhand summaries; Lore is credited as the closest relative and earlier (March 2026 preprint), since it is, and its richer field set is named as a reason to choose it. The synced AGENTS.md block section was carried over byte for byte so sync-docs stays clean","touches":["README.md","SPEC.md"]}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant